-
Notifications
You must be signed in to change notification settings - Fork 535
Updates to contributors guide #2031
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
alexakreizinger
wants to merge
13
commits into
master
Choose a base branch
from
alexakreizinger/sc-143151/updates-to-contributor-s-guide
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Updates to contributors guide #2031
alexakreizinger
wants to merge
13
commits into
master
from
alexakreizinger/sc-143151/updates-to-contributor-s-guide
+113
−149
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Alexa Kreizinger <[email protected]>
Signed-off-by: Alexa Kreizinger <[email protected]>
Signed-off-by: Alexa Kreizinger <[email protected]>
Signed-off-by: Alexa Kreizinger <[email protected]>
Signed-off-by: Alexa Kreizinger <[email protected]>
Signed-off-by: Alexa Kreizinger <[email protected]>
Signed-off-by: Alexa Kreizinger <[email protected]>
Signed-off-by: Alexa Kreizinger <[email protected]>
Signed-off-by: Alexa Kreizinger <[email protected]>
Signed-off-by: Alexa Kreizinger <[email protected]>
Signed-off-by: Alexa Kreizinger <[email protected]>
Signed-off-by: Alexa Kreizinger <[email protected]>
Signed-off-by: Alexa Kreizinger <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
got rid of some defunct/redundant sections, played musical chairs with other sections for clarity, and added a "quick tips" section at the top for anyone who's just skimming.
if I went too far removing stuff, I can definitely revert some of these changes, but my thought process there is that too much content makes it harder for contributors to find (and follow) the guidelines that matter most. same rationale there for putting certain items in a collapsible
<details>
element.I also opted to remove the list of active vale/markdownlint tests because I think that info is more interesting to maintainers than to contributors, and therefore more trouble than it's worth to keep current. (unless I'm mistaken, some of the warning-versus-error distinctions were already out of date.) again, not a hill I'll die on, but I would argue that linking to the place where the tests actually live is more than enough.
also also, the diff for this one is not super cute. to see how the updated contribution guide actually renders for readers, go here: https://github.com/fluent/fluent-bit-docs/blob/alexakreizinger/sc-143151/updates-to-contributor-s-guide/CONTRIBUTING.md